Public Class FileItem

Properties Detail

• ItemName (Get)

  Public Property Get ItemName As String
  Name of the item

Methods Detail

• FindFileResource

  Public Function FindFileResource() As FileResource

  Search a database for a design element of a given name and type (type being, for instance, "xpage" or "stylesheet"). This is only suitable for design elements of the type that contain binary-encoded file data, which is usually but not always in an item named $FileData. NOTE: This has the same drawback as NotesDatabase.GetView and the like, in that if there are multiple design elements with the same name you will only find one of them. It may be better to use NotesNoteCollection to locate the design elements yourself and call MakeFileResource instead.

• MakeFileResource

  Public Function MakeFileResource(docDes As NotesDocument) As FileResource
  Given the NotesDocument handle of a design element (which you've probably found using NotesNoteCollection), creates a FileResource object representing that design element. Note this is only suitable for use with design elements of the "file resource" type.
  idx	Argument	Data Type	Attributes	Comments
  1	docDes	NotesDocument		Handle to the design element.

• Load

  Public Sub Load()

  Populate the Stream object with the decoded contents of the file. Note you can assign Stream first with your own object, if you want to store the result in a file. Note that nothing is said here about character set; you data are treated as binary. If you supply a stream that's attached to a file, you can specify the character set when you open the file. Otherwise, if you need to read the contents as character data, see StreamToText function (not method!). If you supply a stream, it will be truncated.

• New

  Public Sub New(parent As FileResource, elnote As NotesDOMElementNode, itemname As String)
  Arguments are the parsed DOM node of the element representing a design element, and the name of the composite item you would like to read, modify or create.
  idx	Argument	Data Type	Attributes	Comments
  1	parent	FileResource		Parent File Resource for new File Item
  2	elnote	NotesDOMElementNode		Parsed DOM Node representing the design element.
  3	itemname	String	ByVal	Name of the item to read, modify, or create

• UpdateFile

  Public Sub UpdateFile(streamIn As NotesStream)
  Take binary file data as input, and create or update the <item> element to store that data as CD records. The streamIn buffer must contain only the data to be written (current position in the stream is ignored).
  idx	Argument	Data Type	Attributes	Comments
  1	streamIn	NotesStream		Binary file data to be written.